Style applying properties, node components and bindings to nodes. More...
#include <kanzi/core.ui/style/style.hpp>
Public Types | |
typedef vector< NodeComponentTemplateSharedPtr > | NodeComponentTemplateContainer |
typedef NodeComponentTemplateContainer::const_iterator | NodeComponentTemplateIterator |
typedef vector< BindingSharedPtr > | BindingContainer |
typedef BindingContainer::const_iterator | BindingIterator |
typedef vector< Node * > | NodeContainer |
typedef NodeContainer::const_iterator | NodeIterator |
typedef NodeContainer::reverse_iterator | NodeReverseIterator |
typedef vector< Object * > | ObjectContainer |
typedef ObjectContainer::const_iterator | ObjectIterator |
typedef ObjectContainer::reverse_iterator | ObjectReverseIterator |
typedef unordered_map< AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource * > | ValueSourceContainer |
typedef ValueSourceContainer::const_iterator | ValueSourceIterator |
typedef pair< AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource * > | ValueSourcePair |
typedef pair< AbstractPropertyType, Variant > | PropertyPair |
typedef vector< PropertyPair > | PropertyContainer |
typedef PropertyContainer::const_iterator | PropertyConstIterator |
![]() | |
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage > | PropertyStoragePtr |
typedef vector< PropertyStoragePtr > | PropertyStorageContainer |
typedef PropertyStorageContainer::iterator | PropertyStorageIterator |
typedef PropertyStorageContainer::const_iterator | PropertyStorageConstIterator |
typedef PropertyStorageContainer::reverse_iterator | PropertyStorageReverseIterator |
Public Member Functions | |
virtual | ~Style () KZ_OVERRIDE |
virtual void | loadFromKZB (const ResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE |
Load a style from kzb. More... | |
ValueSourceIterator | beginProperties () |
Gets an iterator to the beginning of container of properties of a style. More... | |
ValueSourceIterator | endProperties () |
Gets an iterator to the end of container of properties of a style. More... | |
PropertyValuePrecedence | getPrecedence () const |
AbstractPropertyTypeDescriptor::ValueSource * | getValueSource (AbstractPropertyType propertyType) |
Get value source for a property type. More... | |
BindingIterator | beginBindings () const |
Gets an iterator to the beginning of container of bindings of a style. More... | |
BindingIterator | endBindings () const |
Gets an iterator to the end of the container of bindings of a style. More... | |
NodeComponentTemplateIterator | beginNodeComponentTemplates () const |
Gets an iterator to the beginning of container of node component templates of a style. More... | |
NodeComponentTemplateIterator | endNodeComponentTemplates () const |
Gets an iterator to the end of the container of node component templates of a style. More... | |
void | setPrecedence (PropertyValuePrecedence precedence) |
Set style properties precedence. More... | |
![]() | |
KzcMemoryManager * | getMemoryManager () const |
Resource (Domain *domain, string_view name) | |
virtual | ~Resource () |
virtual void | unloadOverride () |
Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More... | |
virtual unsigned int | getCPUMemoryUsage () const |
Function for getting the memory usage of a resource. More... | |
void | setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path) |
Set the binary directory and path of the resource. More... | |
const string & | getName () const |
Gets the resource name. More... | |
const string & | getUrl () const |
Gets the resource URL. More... | |
void | setUrl (string_view url) |
Sets the resource URL. More... | |
void | setNotLoaded () |
bool | isFromKZB () const |
void | reload () |
void | reloadFromKzb (KzcInputStream *inputStream, const KzuBinaryFileInfo *file) |
void | reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) |
void | reloadFromFile (string_view filePath) |
void | load () |
void | unload () |
bool | isLoaded () const |
void | kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext) |
Private function for kzuResourceLoad() with specified thread context. More... | |
void | kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext) |
Private function for finishing the loading of the resource. More... | |
bool | isKeepAlive () const |
Tells if the resource has keep alive flag set. More... | |
void | setKeepAlive (bool keepAlive) |
Sets the keep alive flag. More... | |
![]() | |
Object (Domain *domain) | |
virtual | ~Object () |
Domain * | getDomain () const |
Returns the domain the object belongs to. More... | |
KzuTaskScheduler * | getTaskScheduler () const |
Returns the task scheduler of the object. More... | |
KzuMessageDispatcher * | getMessageDispatcher () const |
Returns the message dispatcher of the object. More... | |
ResourceManager * | getResourceManager () const |
Returns the resource manager of the object. More... | |
virtual const Metaclass * | getDynamicMetaclass () const KZ_OVERRIDE |
Returns the metaclass of the dynamic type of the object. More... | |
AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. More... | |
void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
void | applyObjectStyles () |
Apply all styles for an object node. More... | |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. More... | |
![]() | |
virtual | ~MetaObject () |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. More... | |
![]() | |
PropertyObject () | |
virtual | ~PropertyObject () |
template<typename DataType > | |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
Sets the local value of a property. More... | |
void | removeKzbProperties () |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property. More... | |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More... | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property disregarding modifiers. More... | |
template<typename DataType > | |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. More... | |
bool | hasBaseValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value, disregarding modifiers. More... | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. More... | |
bool | hasNonClassValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a value of any precedence higher than class default value set for the property. More... | |
void | removeLocalValue (AbstractPropertyType propertyType) |
Removes the local value associated with the property. More... | |
void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
Copies local value of single property from another object. More... | |
void | copyLocalValues (const PropertyObject &other) |
Copies all local values from another object. More... | |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
Virtual function to handle property change notifications. More... | |
template<typename DataType > | |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner) |
template<typename DataType > | |
void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner) |
template<typename DataType > | |
void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
template<typename DataType > | |
void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
void | validatePropertyModifiers (AbstractPropertyType propertyType) |
template<typename DataType > | |
void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
template<typename DataType > | |
void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
template<typename DataType > | |
size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) |
Gets number of current notification handlers for given property type. More... | |
Static Public Member Functions | |
static StyleSharedPtr | create (Domain *domain, string_view name, StyleSharedPtr parentStyle, const Metaclass *objectType, const PropertyContainer &properties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponentTemplates) |
static StyleSharedPtr | createWithValueModifiers (Domain *domain, string_view name, StyleSharedPtr parentStyle, const Metaclass *objectType, const PropertyContainer &properties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponentTemplates) |
static Style * | createEmpty (Domain *domain, string_view name) |
Create an empty style. More... | |
static Style * | copy (const Style *sourceStyle) |
Copy a style. More... | |
static StyleSharedPtr | loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) |
Loads a style dictionary from a file. More... | |
static void | apply (AppliedStyleEntrySharedPtr appliedStyleEntry, Node *objectNode) |
Apply a style. More... | |
static void | unapply (AppliedStyleEntrySharedPtr appliedStyleEntry, Node *objectNode) |
Unapply a style. More... | |
static void | applyAll (Node *applyObjectNode) |
Apply all styles to an object node. More... | |
static void | apply (AppliedStyleEntrySharedPtr appliedStyleEntry, Object *object) |
Apply a style (generic). More... | |
static void | unapply (AppliedStyleEntrySharedPtr appliedStyleEntry, Object *object) |
Unapply a style (generic). More... | |
![]() | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. More... | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. More... | |
![]() | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. More... | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. More... | |
Static Protected Member Functions | |
static bool | applyTypedStyle (Node &target, const ResourceDictionary &dictionary) |
static bool | applyTypedStyle (Node &target, const Node &scope) |
static void | copyBindings (const BindingContainer &source, BindingContainer &target) |
Copies bindings from one array to another. More... | |
static Style * | createInternal (Domain *domain, string_view name, StyleSharedPtr parentStyle, optional< const Metaclass * > objectType, const PropertyContainer &properties, const ValueSourceContainer *hashProperties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponents, bool useValueModifiers) |
Internal create function. More... | |
Protected Attributes | |
StyleSharedPtr | m_parent |
Parent style. More... | |
optional< const Metaclass * > | m_objectType |
Object type this style applies to, nullptr if the style applies to any type, or nullopt if there is no target type. More... | |
bool | m_useValueModifiers |
Does this style apply value modifiers or value sources. More... | |
PropertyValuePrecedence | m_precedence |
Property precedence of this style. More... | |
ValueSourceContainer | m_valueSources |
Property values of this style. More... | |
BindingContainer | m_bindings |
Bindings of this style . More... | |
NodeComponentTemplateContainer | m_nodeComponentTemplates |
Node component templates of this style. More... | |
![]() | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. More... | |
Additional Inherited Members | |
![]() | |
typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
Applied style container. More... | |
Style applying properties, node components and bindings to nodes.
typedef NodeComponentTemplateContainer::const_iterator kanzi::Style::NodeComponentTemplateIterator |
typedef vector<BindingSharedPtr> kanzi::Style::BindingContainer |
typedef BindingContainer::const_iterator kanzi::Style::BindingIterator |
typedef vector<Node*> kanzi::Style::NodeContainer |
typedef NodeContainer::const_iterator kanzi::Style::NodeIterator |
typedef NodeContainer::reverse_iterator kanzi::Style::NodeReverseIterator |
typedef vector<Object*> kanzi::Style::ObjectContainer |
typedef ObjectContainer::const_iterator kanzi::Style::ObjectIterator |
typedef ObjectContainer::reverse_iterator kanzi::Style::ObjectReverseIterator |
typedef unordered_map<AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource*> kanzi::Style::ValueSourceContainer |
typedef ValueSourceContainer::const_iterator kanzi::Style::ValueSourceIterator |
typedef pair<AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource*> kanzi::Style::ValueSourcePair |
typedef pair<AbstractPropertyType, Variant> kanzi::Style::PropertyPair |
typedef vector<PropertyPair> kanzi::Style::PropertyContainer |
typedef PropertyContainer::const_iterator kanzi::Style::PropertyConstIterator |
|
virtual |
|
protected |
|
static |
|
static |
Create an empty style.
|
virtual |
Load a style from kzb.
Reimplemented from kanzi::Resource.
|
static |
ValueSourceIterator kanzi::Style::beginProperties | ( | ) |
Gets an iterator to the beginning of container of properties of a style.
ValueSourceIterator kanzi::Style::endProperties | ( | ) |
Gets an iterator to the end of container of properties of a style.
|
inline |
AbstractPropertyTypeDescriptor::ValueSource* kanzi::Style::getValueSource | ( | AbstractPropertyType | propertyType | ) |
Get value source for a property type.
BindingIterator kanzi::Style::beginBindings | ( | ) | const |
Gets an iterator to the beginning of container of bindings of a style.
BindingIterator kanzi::Style::endBindings | ( | ) | const |
Gets an iterator to the end of the container of bindings of a style.
NodeComponentTemplateIterator kanzi::Style::beginNodeComponentTemplates | ( | ) | const |
Gets an iterator to the beginning of container of node component templates of a style.
NodeComponentTemplateIterator kanzi::Style::endNodeComponentTemplates | ( | ) | const |
Gets an iterator to the end of the container of node component templates of a style.
|
static |
Apply a style.
|
static |
Unapply a style.
|
static |
Apply all styles to an object node.
|
static |
Apply a style (generic).
|
static |
Unapply a style (generic).
void kanzi::Style::setPrecedence | ( | PropertyValuePrecedence | precedence | ) |
Set style properties precedence.
|
staticprotected |
|
staticprotected |
Copies bindings from one array to another.
|
protected |
Copies parent style properties.
|
protected |
Extracts property metadata for a style.
|
staticprotected |
Internal create function.
|
protected |
Empties contents of a style.
|
protected |
Parent style.
|
protected |
Object type this style applies to, nullptr if the style applies to any type, or nullopt if there is no target type.
|
protected |
Does this style apply value modifiers or value sources.
|
protected |
Property precedence of this style.
|
protected |
Property values of this style.
<KzuPropertyType, void* (value source)>.
|
protected |
Bindings of this style .
|
protected |
Node component templates of this style.